Automatic generation of run-time instrumenter

ABSTRACT

A method and apparatus for automatically generating a run-time instrumenter are disclosed. In accordance with the illustrative embodiment, an off-line analyzer first determines instrumentation locations for a program under test in accordance with a method called the Super Nested Block Method. After the instrumentation locations have been determined, source code for a run-time instrumenter is automatically generated based on the source code for the program under test and the instrumentation locations. The source code for the program under test and the run-time instrumenter are then compiled into executables, and a testing tool then executes the program under test and the run-time instrumenter in parallel.

FIELD OF THE INVENTION

The present invention relates to run-time analysis of software in general, and, more particularly, to a method and apparatus for automatically generating a run-time instrumenter.

BACKGROUND OF THE INVENTION

Instrumentation is a technique that can enable engineers to comprehend, monitor, and assess the operation of software. Typically, a program is instrumented by inserting probes at various points in the program, where the probes report a variety of information such as whether certain portions of a program have been reached (referred to as coverage), the number of times that various portions of the program have been executed (referred to as execution counts), how much time is spent in various portions of the program, and so forth. Instrumentation thus facilitates the identification of coverage efficiency, bottlenecks, bugs, and other deficiencies in a program and, consequently, can aid in the process of improving the quality, security, efficiency, and performance of programs.

The introduction of probes into a program, however, adds overhead that can slow down the execution of the program, and thus there is a tradeoff when inserting probes into a program. Ideally, the probes should cover all of the various execution paths of the program, and should be sufficient in number so that the reported information is fine-grained enough to be useful. However, if there are too many probes, then program runtime performance might suffer appreciably, which is unacceptable in applications such as real-time embedded systems and Voice over Internet Protocol (VoIP).

Typically methods for determining probe insertion points in a program are based on a control-flow graph that is derived from the program. FIG. 1 depicts illustrative program 100, and FIG. 2 depicts control-flow graph 200 corresponding to program 100, both in accordance with the prior art. As shown in FIG. 2, control-flow graph 200 comprises nodes 201-1 through node 201-13, connected by arcs as shown. For convenience, each node of control-flow graph 200 has been assigned a label that indicates the portion of program 100 (known as a basic block) to which it corresponds.

In one method of the prior art, known as a maximum spanning tree method, arcs are first added to the control-flow graph, as necessary, so that at each node, the incoming execution count equals the outgoing execution count. Weights are then assigned to the arcs of the (possibly-augmented) control-flow graph, and a maximum spanning tree is generated (i.e., a spanning tree such that the sum of its arc weights is maximum.) Finally, a probe is inserted at every node in the control-flow graph that leads to an arc not in the spanning tree.

FIG. 3 depicts an illustrative maximum spanning tree for control-flow graph 200, indicated by boldface arcs, in accordance with the prior art. (For simplicity, weights are not depicted in the figure.) As shown in FIG. 3, an arc from node 201-13 to node 201-1 has been added to ensure that the incoming and outgoing execution counts are equal at each node.

It is readily apparent from FIG. 3 that the following arcs are not part of the spanning tree:

-   -   (201-6, 201-8) [B-E6],     -   (201-9, 201-11) [D-E6E]     -   (201-4, 201-12) [F-E1E]     -   (201-12, 201-2) [E1E-E1]     -   (201-2, 201-13) [E1-G]         Consequently, probes are inserted in nodes B, D, F, E1E, and E1.

A key disadvantage of the maximum spanning tree method is that it requires execution counts on each probe, which can consume a great deal of memory. Moreover, the counter values can grow so large that they impact the original application, and there is no way to reset the counters. Consequently, the maximum spanning tree method is typically not practical for program monitoring during field operation.

In another method of the prior art, known as a super block dominator method, a pre-dominator tree of the control-flow graph is first generated—i.e., a tree in which a first node is an ancestor of a second node if and only if the first node is guaranteed to execute before the second node. FIG. 4 depicts pre-dominator tree 400 for control-flow graph 200, in accordance with the prior art.

Next, a post-dominator tree of the control-flow graph is generated—i.e., a tree in which a first node is a descendent of a second node if and only if the first node is guaranteed to execute before the second node. FIG. 5 depicts post-dominator tree 500 for control-flow graph 200, in accordance with the prior art.

The pre-dominator and post-dominator trees are then combined into a single dominator graph. FIG. 6 depicts dominator graph 600 for control-flow graph 200, in accordance with the prior art. Dominator graph 600 is simply the union of pre-dominator tree 400 and post-dominator tree 500, and can be obtained by adding the arcs of post-dominator tree 500 to pre-dominator tree 400.

Next, the strongly-connected components of the dominator graph are determined. A strongly-connected component is a maximal set of nodes in a directed graph such that every node in the set is reachable from every other node in the set. FIG. 7 depicts the strongly-connected components of dominator graph 600, in accordance with the prior art.

Finally, each strongly-connected component is defined as a respective super block, and a probe is inserted in each of the super blocks. In this example, a probe is inserted into each of the following super blocks of program 100: {A, E1, G}, {E2, E1E}, {F}, {E3, E6, E6E}, {B}, {C}, {D}, and {E}.

SUMMARY OF THE INVENTION

The present invention enables the automatic generation of a run-time instrumenter for a program under testing. In accordance with the illustrative embodiments, an off-line analyzer first determines instrumentation locations for a program under test in accordance with a method called the Super Nested Block Method. After the instrumentation locations have been determined, source code for a run-time instrumenter is automatically generated based on the source code for the program under test and the instrumentation locations. The source code for the program under test and the run-time instrumenter are then compiled into executables, and a testing tool then executes the program under test and the run-time instrumenter in parallel.

The illustrative embodiment comprises: a processor for generating a first program that performs run-time instrumentation of a second program; and a memory for storing the first program.

BRIEF DESCRIPTION OF THE DRAWINGS

FIG. 1 depicts an outline of illustrative program 100, in accordance with the prior art.

FIG. 2 depicts a control-flow graph corresponding to illustrative program 100, in accordance with the prior art.

FIG. 3 depicts an illustrative maximum spanning tree of control-flow graph 200, as shown in FIG. 2, for a first instrumentation method of the prior art.

FIG. 4 depicts a pre-dominator tree for control-flow graph 200 for a second instrumentation method of the prior art.

FIG. 5 depicts a post-dominator tree for control-flow graph 200 for a second instrumentation method of the prior art.

FIG. 6 depicts a dominator graph for control-flow graph 200 for a second instrumentation method of the prior art.

FIG. 7 depicts the strongly-connected components of dominator graph 600, as shown in FIG. 6, for a second instrumentation method of the prior art.

FIG. 8 depicts the high-level architecture of a first illustrative embodiment of the present invention.

FIG. 9 depicts a flowchart of the Super Nested Block Method, in accordance with the illustrative embodiments of the present invention.

FIG. 10 depicts a data-processing system for instrumenting programs in accordance with the first illustrative embodiment of the present invention.

FIG. 11 depicts the salient contents of memory 1020, as shown in FIG. 10, in accordance with the first illustrative embodiment of the present invention.

FIG. 12 depicts the high-level architecture of a second illustrative embodiment of the present invention.

FIG. 13 depicts a flowchart of the salient tasks performed by off-line analyzer 810, testing tool 830, auto generator 1201, compiler 1202, and run-time instrumenter 1220, as shown in FIGS. 8 and 12, in accordance with the second illustrative embodiment of the present invention.

FIG. 14 depicts a data-processing system for instrumenting programs in accordance with the second illustrative embodiment of the present invention.

FIG. 15 depicts the salient contents of memory 1420, as shown in FIG. 14, in accordance with the first illustrative embodiment of the present invention.

DETAILED DESCRIPTION

FIG. 8 depicts the high-level architecture of a first illustrative embodiment of the present invention. As shown in FIG. 8, the first illustrative embodiment comprises off-line analyzer 810, run-time instrumenter 820, and testing/monitoring tool 830, interconnected as shown.

Off-line analyzer 810 comprises software, or hardware, or a combination of software and hardware capable of determining one or more locations in a program at which an instrumentation probe is to be inserted. The determination of instrumentation locations by off-line analyzer 810—referred to as the Super Nested Block Method—is described in detail below. The method is first described informally as applied to illustrative control-flow graph 200, and subsequently a formal specification of the method is provided.

Informal Description of the Super Nested Block Method

An informal description of the Super Nested Block Method as applied to illustrative control-flow graph 200 is first provided in this section. A formal specification of the method is subsequently provided in the following section.

In the first task of the method, the first layer of super nested block starting with the root node (i.e., node 201-1 or “A” for control-flow graph 200) is identified. In the case of control-flow graph 200, the first layer of super nested block consists of node 201-1 (A), node 201-2 (E1), node 201-12 (E1E), and node 210-13 (G), which corresponds to the following lines of code:

Non-branching statementA1; Non-branching statementA2; ...... Non-branching statementAn; While Expression1 { } Non-branching statementG1; Non-branching statementG2; ...... Non-branching statementGs; } As will be appreciated by those skilled in the art, after reading this specification, the lines of code above constitute a super nested block, because for any two consecutive lines of code X and Y in the block, if X is executed, then Y is also executed at some point after the execution of X, albeit possibly with one or more other lines of code executed in between X and Y. This first super nested block is subsequently referred to as SNB1.

The second task of the method checks whether the current super nested block (at this point, SNB1) has any branching statements. If not (i.e., the super nested block comprises a single node of the control-flow graph, and is thus simply a basic block), the single node is marked “probe-needed”. Otherwise, one of the child nodes of the current super nested block is marked as “sum-needed”, and each child node, which is the root of a second-layer (or “child”) super nested block, is expanded (i.e., processed in accordance with this method). The child super nested blocks, in combination with the current super nested block (at this point, SNB1), is referred to as a super nested block group.

In the case of control-flow graph 200, super nested block SNB1 has a single child node, node 201-3 (E2), and thus at the second task, node 201-3 is marked as “sum-needed,” and is then expanded, as described below.

The marking “sum-needed” means that the summation of this super nested block group will be used to calculate the current super nested block's execution counts. (As will be appreciated by those skilled in the art, after reading this disclosure, it can be shown that the execution count of a super nested block is the summation of execution counts of all super nested blocks inside any one of the child super nested block groups.)

Super nested block groups that lack a “sum-needed” mark do not require execution counts for every child super nested block—one of the child super nested block groups does not need an execution count probe. Naturally, if possible, it is advantageous to select the child super nested block with the highest potential execution count as the one that is not marked “sum-needed”.

In the case of control-flow graph 200, the second layer of super nested block is the first-layer statements inside the while loop, starting from E2. This second super nested block, SNB2, consists of a single node, node 201-3 (E2), which corresponds to the following lines of code:

If Expression2 { ...... } else { ...... }

The second task is then repeated for super nested block SNB2. Because SNB2 includes a branching statement, it is further expanded into a third layer with two super nested blocks. The first third-layer super nested block, SNB31, consists of node 201-5 (E3), node 201-8 (E6), and node 201-11 (E6E) and corresponds to the following lines of code:

Switch Expression3 { ...   }   If Expression6 { ...   } else {   ...   }

Because super nested block SNB31 has more than one branching statement, one of them must be selected to be marked as “sum-needed”. Assuming that node 201-8 (E6) is selected, all child nodes of node 201-8 (E6)—namely node 201-9 (D) and node 201-10 (E).

Because node 201-5 (E3) of super nested block SNB31 is not marked “sum-needed”, one if its child nodes 201-6 (B) and 201-7 (C) does not need to be processed. Assuming that node 201-7 (C) is chosen to be excluded from processing, node 201-6 (B) is processed by being marked “probe-needed,” as it does not have any branching statements (i.e., it is a basic block).

The second third-layer super nested block, SNB32, consists of node 201-4 (F), and corresponds to the following lines of code:

Non-branching statementF1; Non-branching statementF2; ...... Non-branching statementFr; Because super nested block SNB32 does not have any branching statements (i.e., it is a basic block), node 201-4 (F) is marked “probe-needed”. The second task is now completed.

In the third and final task, a probe is inserted into the portions of source program 100 that correspond to the nodes marked “probe-needed”: node 201-6 (B), node 201-7 (C), node 201-9 (D), node 201-10 (E), and node 201-4 (F).

As will be appreciated by those skilled in the art, the expansion of subsequent layers of the control-flow graph lends itself very well to a recursive implementation, and this is in fact how the method is formally specified in the subsequent section. As will further be appreciated by those skilled in the art, in some other embodiments of the present invention the expansion might be performed in an alternative, non-recursive, fashion (e.g., iteratively via a breadth-first search traversal of the control-flow graph, etc.), and it will be clear to those skilled in the art, after reading this disclosure, how to make and use such alternative embodiments.

Formal Specification of the Super Nested Block Method

FIG. 9 depicts a flowchart of the salient tasks of the Super Nested Block Method, in accordance with the illustrative embodiments of the present invention. In the illustrative embodiments of the present invention, the method of FIG. 9 is performed by off-line analyzer 810.

At task 910, the root node of control-flow graph G is marked as “sum-needed”.

At task 915, variable S is initialized to a singleton set containing the root node.

Task 920 checks whether there is a node V in S and a node W in G-S such that execution of the last line of code of V implies execution of the first line of code of W. If so, execution proceeds to task 930, otherwise execution continues at task 940.

At task 930, node W is added to set S.

Task 940 checks whether at least one node of set S has a branch statement. If so, execution proceeds to task 950, otherwise execution continues at task 990.

At task 950, one node of set S is marked as “sum-needed”.

Task 960 checks whether the root node is marked “sum-needed”. If so, execution proceeds to task 965, otherwise execution proceeds to task 970.

At task 965, the method is performed recursively for every child node of set S. After task 965, execution continues at task 990.

At task 970, the method is performed recursively for some but not all child nodes of set S. After task 970, execution continues at task 990.

At task 980, one node of set S is marked as “probe-needed”.

At task 990, the program corresponding to control-flow graph G is modified to count the number of times that each node marked “probe-needed” is executed. After task 990, the method of FIG. 9 terminates.

Run-time instrumenter 820 comprises software, or hardware, or a combination of software and hardware capable of instrumenting program P during program P's execution, in well-known fashion. In accordance with the first illustrative embodiment of the present invention, run-time instrumenter 820 replaces each instrumentation location in the executing program (e.g., executable program P, etc.) with code patches for saving registers, running probes, restoring registers, removing probes after the first time that they are executed, and putting back the original code at the instrumentation location. In addition, run-time instrumenter 820 uses the probes to generate and report code coverage information concerning the execution of program P. In some embodiments of the present invention, run-time instrumenter 820 might report code coverage information after the execution of program P has completed, while in some other embodiments, run-time instrumenter 820 might report code coverage information during the execution of program P, while in still some other embodiments run-time instrumenter 820 might report code coverage information both during and after the execution of program P.

The automatic generated run-time instrumenter includes two parts: the static creation and dynamic parameter setting. The static part includes the following program portions: 1) create a patch object as the one single instance of the top-level class; 2) create a new process of the program under testing or have a running one attached; 3) create a probe; 4) set instrumentation points; 5) insert the probe to the instrumentation points; 6) repeat parts 3), 4), and 5) until all instrumentation points are properly handled. The dynamic part is the memory size and value of instrumentation location.

Testing/monitoring tool 830 comprises software, or hardware, or a combination of software and hardware capable of running a run-time instrumenter (e.g., run-time instrumenter 820, etc.) and an executable under test (e.g., executable program P, etc.) in parallel, in well-known fashion. During the testing of the target program, whenever the instrumentation point is reached, the execution is redirected to the code patches of saving registers, running probes, restoring registers, and restoring the original code back to the instrumentation point.

FIG. 10 depicts data-processing system 1000 for instrumenting programs in accordance with the first illustrative embodiment of the present invention. As shown in FIG. 10, data-processing system 1000 comprises processor 1010 and memory 1020, interconnected as shown.

Processor 1010 is a general-purpose processor that is capable of executing instructions stored in memory 1020, of reading data from and writing data into memory 1020, and of executing the tasks associated with off-line analyzer 810 and run-time instrumenter 820, as described above. As will be appreciated by those skilled in the art, in some alternative embodiments of the present invention, processor 1010 might instead be a special-purpose processor; in any case, it will be clear to those skilled in the art, after reading this disclosure, how to make and use processor 1010.

Memory 1020 stores data, program source code, and executable instructions, as is well-known in the art, and might be any combination of random-access memory (RAM), flash memory, disk drive, etc. In accordance with the first illustrative embodiment of the present invention, memory 1020 stores the source code for a particular program P to be instrumented, the executable instructions (i.e., object code) for program P, an executable program for performing the tasks of off-line analyzer 810, and an executable program for performing the tasks of run-time instrumenter 820, as shown in FIG. 11.

FIG. 12 depicts the high-level architecture of a second illustrative embodiment of the present invention. As shown in FIG. 12, the second illustrative embodiment comprises off-line analyzer 810 and testing tool 830 of the first illustrative embodiment, as well as auto generator 1201, compiler 1202, and run-time instrumenter 1220, interconnected as shown.

Auto generator 1201 comprises software, or hardware, or a combination of software and hardware that is capable of generating source code for a run-time instrumenter based on (i) the source code for program P, and (ii) the instrumentation locations determined by off-line analyzer 810. In accordance with the second illustrative embodiment of the present invention, auto generator 1201 generates source code for the run-time instrumenter that is in the same programming language as program P. The auto generator first generates a template of the code, and then replaces the dynamic portion, memory size and probe locations with actual value calculated from the analysis step. The code is output in the same programming language as the original program under testing/monitoring.

Compiler 1202 comprises software, or hardware, or a combination of software and hardware that is capable of generating an executable program from source code, in well-known fashion.

Run-time instrumenter 1220 is an executable software program capable of instrumenting program P during program P's execution, in well-known fashion. In accordance with the second illustrative embodiment of the present invention, run-time instrumenter 1220 replaces each instrumentation location in program P with code patches for saving registers, running probes, restoring registers, removing probes after the first time that they are executed, and putting back the original code at the instrumentation location. In addition, run-time instrumenter 1220 reports code coverage information concerning the execution of program P. In some embodiments of the present invention, run-time instrumenter 1220 might report code coverage information after execution of program P has completed, while in some other embodiments, run-time instrumenter 1220 might report code coverage information during the execution of program P, while in still some other embodiments run-time instrumenter 1220 might report code coverage information both during and after the execution of program P.

FIG. 13 depicts a flowchart of the salient tasks performed by off-line analyzer 810, testing tool 830, auto generator 1201, compiler 1202, and run-time instrumenter 1220, in accordance with the second illustrative embodiment of the present invention.

At task 1310, off-line analyzer 810 determines instrumentation locations for program P in accordance with the method of FIG. 9, as described above.

At task 1320, auto generator 1201 generates source code for run-time instrumenter that is in the same programming language as program P, based on the program P source code and the instrumentation locations determined at task 1310, as described above.

At task 1330, compiler 1202 compiles the program P source code and run-time instrumenter source code, generating a program P executable and run-time instrumenter 1220, in well-known fashion.

At task 1340, testing tool 830 executes program P and run-time instrumenter 1220 in parallel, in well-known fashion.

After task 1340 is completed, the method of FIG. 13 terminates.

FIG. 14 depicts data-processing system 1400 for instrumenting programs in accordance with the second illustrative embodiment of the present invention. As shown in FIG. 14, data-processing system 1400 comprises processor 1410 and memory 1420, interconnected as shown.

Processor 1410 is a general-purpose processor that is capable of executing instructions stored in memory 1420, of reading data from and writing data into memory 1420, and of executing the tasks associated with off-line analyzer 810, auto-generator 1201, compiler 1202, and run-time instrumenter 1220, as described above. As will be appreciated by those skilled in the art, in some alternative embodiments of the present invention, processor 1410 might instead be a special-purpose processor; in any case, it will be clear to those skilled in the art, after reading this disclosure, how to make and use processor 1410.

Memory 1420 stores data, program source code, and executable instructions, as is well-known in the art, and might be any combination of random-access memory (RAM), flash memory, disk drive, etc. In accordance with the second illustrative embodiment, memory 1420 stores the source code for a particular program P to be instrumented, the executable instructions (i.e., object code) for program P, an executable program for performing the tasks of off-line analyzer 810, the auto-generated run-time instrumenter source code, and executable run-time instrumenter 1220, as shown in FIG. 15. Memory 1420, a computer-readable storage, or a computer-readable device expressly excludes signals per se and the like.

It is to be understood that the disclosure teaches just one example of the illustrative embodiment and that many variations of the invention can easily be devised by those skilled in the art after reading this disclosure and that the scope of the present invention is to be determined by the following claims. 

What is claimed is:
 1. A system comprising: a processor; and a computer-readable storage device storing instructions which, when executed by the processor, cause the processor to perform operations comprising: identifying a block in program source code, wherein: (i) for any two consecutive lines of code within the block, when a first line of the two consecutive lines executes at a first time, the second line of the two consecutive lines executes at a second time later than the first time; and (ii) for a pair of consecutive lines of code, line X and line Y, within the block, another line of code is executed between the line X and the line Y; determining, based on (a) an analysis of the block and a control-flow graph of the block which indicates execution of a first node in the block implies execution of a first line of a second node in the block, and (b) a branch statement located within the block, an instrumentation location in the program source code; generating run-time instrumenter source code based on the program source code and the instrumentation location; compiling the program source code to yield a program; compiling the run-time instrumenter source code to yield a run-time instrumenter executable; and executing the program and the run-time instrumenter executable on a single device in parallel.
 2. The system of claim 1, wherein the program is for a real-time system.
 3. The system of claim 1, wherein the computer-readable storage device stores additional instructions which, when executed by the processor, cause the processor to perform the operations further comprising receiving an input that specifies a location in the program source code to yield another instrumentation location.
 4. The system of claim 3, wherein the computer-readable storage device stores additional instructions which, when executed by the processor, cause the processor to perform the operations further comprising inserting a probe at a specific location in the program during an execution of the program.
 5. The system of claim 4, wherein the computer-readable storage device stores additional instructions which, when executed by the processor, cause the processor to perform the operations further comprising removing the probe after the probe has been executed once.
 6. A method comprising: identifying a block in program source code, wherein: (i) for any two consecutive lines of code within the block, when a first line of the two consecutive lines executes at a first time, the second line of the two consecutive lines executes at a second time later than the first time; and (ii) for a pair of consecutive lines of code, line X and line Y, within the block, another line of code is executed between the line X and the line Y; determining, based on (a) an analysis of the block and a control-flow graph of the block which indicates execution of a first node in the block implies execution of a first line of a second node in the block, and (b) a branch statement located within the block, an instrumentation location in the program source code; generating, via a processor, run-time instrumenter source code based on the program source code and the instrumentation location; compiling the program source code to yield a program; compiling the run-time instrumenter source code to yield a run-time instrumenter executable; and executing the program and the run-time instrumenter executable on a single device in parallel.
 7. The method of claim 6, wherein the program is for a real-time system.
 8. The method of claim 6, further comprising receiving an input that specifies a location in the program source code to yield another instrumentation location.
 9. The method of claim 8, further comprising inserting a probe at a specific location in the program during the execution of the program.
 10. The method of claim 9, further comprising removing the probe after the probe has been executed once.
 11. A non-transitory computer-readable storage device storing instructions which, when executed by a processor, cause the processor to perform operations comprising: identifying a block in program source code, wherein: (i) for any two consecutive lines of code within the block, when a first line of the two consecutive lines executes at a first time, the second line of the two consecutive lines executes at a second time later than the first time; and (ii) the block is not a basic block; determining, based on (a) an analysis of the block and a control-flow graph of the block which indicates execution of a first node in the block implies execution of a first line of a second node in the block, and (b) a branch statement located within the block, an instrumentation location in the program source code; generating run-time instrumenter source code based on the program source code and the instrumentation location; compiling the program source code to yield a program; compiling the run-time instrumenter source code to yield a run-time instrumenter executable; and executing the program and the run-time instrumenter executable on a single device in parallel.
 12. The system of claim 1, wherein the run-time instrumenter executable generates a report of code coverage of the program after the program is executed.
 13. The method of claim 6, wherein the run-time instrumenter executable generates a report of code coverage of the program after the program is executed.
 14. The non-transitory computer-readable storage device of claim 11, wherein the run-time instrumenter executable generates a report of code coverage of the program after the program is executed.
 15. The method of claim 6, wherein generating the run-time instrumenter source code is done without user input. 